HeaderBar: Explain use in conjunction w/ GtkWindow
authorDaniel Boles <dboles@src.gnome.org>
Fri, 12 Jan 2018 22:56:11 +0000 (22:56 +0000)
committerDaniel Boles <dboles@src.gnome.org>
Sat, 13 Jan 2018 20:06:20 +0000 (20:06 +0000)
After hinting how good GtkHeaderBar is for GtkWindow, let’s link to
the latter and indicate how users can make the two work together.

gtk/gtkheaderbar.c

index 08e975749c3614ccaf655299f0175149f4328103..34aedc71a6db4c9554a685e8195681a615e6e648 100644 (file)
  *
  * GtkHeaderBar can add typical window frame controls, such as minimize,
  * maximize and close buttons, or the window icon.
+ *
+ * For these reasons, GtkHeaderBar is the natural choice for use as the custom
+ * titlebar widget of a #GtkWindow (see gtk_window_set_titlebar()), as it gives
+ * features typical of titlebars while allowing the addition of child widgets.
  */
 
 #define DEFAULT_SPACING 6